Skip to content

fix: readme examples, add tests for all examples#626

Merged
bshaffer merged 4 commits intomainfrom
fix-readme-examples
Mar 27, 2026
Merged

fix: readme examples, add tests for all examples#626
bshaffer merged 4 commits intomainfrom
fix-readme-examples

Conversation

@bshaffer
Copy link
Copy Markdown
Collaborator

fixes #625

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the project's documentation by rectifying inaccuracies in the README.md code examples and establishing a robust testing framework for them. By ensuring that all documented examples are functional and up-to-date, this change improves the reliability of the documentation and provides a better experience for developers integrating the library.

Highlights

  • Readme Examples Fixed: Corrected and improved various code examples in README.md for accuracy and clarity, including key generation, payload values, and HTTP factory usage.
  • Automated Example Testing: Introduced a new ReadmeTest.php file to automatically extract and execute all code examples from README.md, ensuring their correctness and preventing future regressions.
  • Dependency Update: Added phpfastcache/phpfastcache as a development dependency to support the new CachedKeySet example testing.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request provides valuable fixes to the README examples and introduces a testing mechanism to ensure they remain valid. The changes, including updating key lengths, fixing namespaces, and improving test instructions, are all positive. The addition of ReadmeTest.php is a great way to maintain documentation quality. I have a couple of minor suggestions for the new test file to improve it further.

@bshaffer bshaffer merged commit 510a00c into main Mar 27, 2026
10 checks passed
@bshaffer bshaffer deleted the fix-readme-examples branch March 27, 2026 20:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants